Skip to main content
GET
/
v1
/
flow
/
{ticker}
/
tide
Per-ticker net-premium time series ("flow tide")
curl --request GET \
  --url https://flow-api.skylit.ai/v1/flow/{ticker}/tide \
  --header 'Authorization: Bearer <token>'
{ "data": { "ticker": "<string>", "bucket": "<string>", "startTime": "2023-11-07T05:31:56Z", "endTime": "2023-11-07T05:31:56Z", "bars": [ { "timestamp": 123, "timestampEnd": 123, "bullishPremium": 123, "bearishPremium": 123, "neutralPremium": 123, "netPremium": 123, "bullishVolume": 1, "bearishVolume": 1, "vwf": 123, "sdf": 123, "fir": 123, "tradeCount": 1, "sweepCount": 1, "netPremiumCumulative": 123 } ], "queryTimeMs": 1 }, "meta": { "timestamp": "2023-11-07T05:31:56Z", "requestId": "d7574836" } }

Authorizations

​
Authorization
string
header
required

Skylit API key in the Authorization header (Authorization: Bearer fs_live_<key>). X-API-Key is also accepted.

Path Parameters

​
ticker
string
required

Underlying ticker symbol (uppercase, e.g. SPY, AAPL).

Example:

"SPY"

Query Parameters

​
startTime
string<date-time>
required

Lower bound of the window (RFC 3339, e.g. 2026-05-27T13:30:00Z).

​
endTime
string<date-time>
required

Upper bound of the window (RFC 3339).

​
bucket
enum<string>
required

Bucket size for the time series. Pre-aggregated tables back the sub-hourly resolutions; coarser buckets fall through to a roll-up.

Available options:
1min,
5min,
15min,
30min,
1h,
1d,
1w
​
optionType
enum<string>
default:all
Available options:
call,
put,
all
​
minPremium
number<double>
​
excludeMultiLeg
boolean
default:false
​
minDte
integer
Required range: x >= 0
​
maxDte
integer
Required range: x >= 0
​
date
string<date>

Response

Per-bucket flow tide bars.

​
data
object
required
​
meta
object
required